wmmemfree: Include only necessary headers.
[dockapps.git] / wmwlmon / wmwlmon.1
blob8ddac21e2a080b7f4a855ddfc8c6faf498084787
1 .\" $Id: wmwlmon.1,v 1.17 2008/05/13 17:42:02 hacki Exp $
2 .\"
3 .\" Copyright (c) 2005, 2006 Marcus Glocker <marcus@nazgul.ch>
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd Jul 9, 2006
18 .Dt WMWLMON 1
19 .Os
20 .Sh NAME
21 .Nm wmwlmon
22 .Nd Wireless Monitor wmdockapp
23 .Sh SYNOPSIS
24 .Nm wmwlmon
25 .Op Fl Dhvw
26 .Op Fl i Ar interface
27 .Op Fl s Ar scrolling
28 .Op Fl display Ar display
29 .Sh DESCRIPTION
30 .Nm
31 is a wmdockapp which shows the state of a wireless network interface.  In the
32 title you see the network interface name and a led showing if the interface
33 link is active.  As next you see the signal strength from the conntected access
34 point in dB (decibel).  The bar shows the signal strength in percents.  If the
35 bar is full, it means that you have the full throughput of the bandwidth
36 displayed in Mbps.  As next you see the channel number.  A red lock shines if
37 WEP is enabled.  The last line shows the network id.
38 .Pp
39 If no interface is set at startup,
40 .Nm
41 scans all initialized interfaces until the first wireless interface is found
42 and uses that.
43 .Sh OPTIONS
44 .Bl -tag -width Ds
45 .It Fl D
46 Debug mode.  Instead starting a wmdockapp, the data is sent to stdout.
47 .It Fl h
48 Prints short listing of
49 .Nm
50 options.
51 .It Fl v
52 Shows version.
53 .It Fl w
54 Enable WaveLAN compatibility.  If a device is named wi* it gets recognized as
55 WaveLAN device automatically.  Otherwise you can force WaveLAN compatibility
56 by this option.
57 .It Fl i Ar interface
58 Set interface.
59 .It Fl s Ar scrolling
60 Network id scrolling.  If a network id is to long to display in the wmdockapp
61 window it will be scrolled by default.  The
62 .Ar scrolling
63 types are:
64 .Pp
65 .Bl -tag -width xxxxxxxxxxxx -compact
66 .It Fl s Cm 0
67 Disable scrolling.  Long network id's will be cut down to 8 characters.
68 .It Fl s Cm 1
69 LCD scrolling (default).  The network id moves from left to right separated by
70 a space.
71 .It Fl s Cm 2
72 Bounce scrolling.  The network id moves from left to right and bounces back
73 from right to left.
74 .It Fl s Cm 3
75 Fade scrolling.  The network id moves from left to right, fading out and
76 begins again.
77 .El
78 .It Fl display Ar display
79 Set display name.
80 .El
81 .Sh HISTORY
82 First version of
83 .Nm
84 appeared in 2005.
85 .Sh THANKS
86 Thanks to Claudio Jeker, Marc Winiger, Marc Balmer, and Matthieu Herrb for
87 their support.
88 .Sh AUTHORS
89 Marcus Glocker
90 .Aq marcus@nazgul.ch
91 .Sh CAVEATS
92 As I can't test
93 .Nm
94 with every wireless chipset for which a driver exists, because I don't have
95 them all, it is most possible that with some chipsets the behavement of
96 .Nm
97 is wrong, or some informations are missing.  If you have such a chipset
98 causing troubles, please report me, including a dmesg and a problem
99 explanation.
101 Full supported devices known yet:
103 .Bl -tag -width Ds -offset indent -compact
104 .It ath(4)
105 .It iwi(4)
106 .It ral(4)
107 .It upgt(4)
108 .It wi(4)
109 .It wpi(4)
112 Partial supported devices known yet:
114 .Bl -tag -width Ds -offset indent -compact
115 .It atw(4)
116 .It ipw(4)