wmshutdown: Destroy dialog window before shutting down. This is especially useful...
[dockapps.git] / wmwifi / wmwifi.1
blob5947d183986fa95dfaa8f9354e43b289f6164628
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH WMWIFI 1 "March 07, 2006"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 wmwifi \- A dockapp to monitor wireless signal strength.
20 .SH SYNOPSIS
21 .B wmwifi [options]
22 .SH DESCRIPTION
23 This manual page documents briefly the
24 .B wmwifi
25 command.
26 This manual page was written for the Debian GNU/Linux distribution.
27 .PP
28 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
29 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
30 .\" respectively.
31 \fBWMWiFi\fP is a dockapp that is supported by X window managers such as
32 Window Maker, AfterStep, BlackBox, and Enlightenment. It monitors all
33 wireless network interfaces on your machine.
35 The main screen displays the link (signal) strength between the currently
36 selected card and your wireless access point as a percentage, and has an
37 LCD look-alike user interface.
39 The second screen diplays extended stats, which are:
40 the current rate/speed in megabits, the noise (in dBm), the level (in dBm),
41 and the actual link amount.
43 Both screens toggle the interface name and the current associated access
44 point at the top every 5 seconds.
46 The back-light may be turned on/off by clicking the mouse
47 button over the application.
49 Mouse1 activates/deactivates the scrolling of the Wireless Interface Name / ESSID.
51 Mouse2 switches the current wireless network interface.
53 Mouse3 switches between standard and extended modes.
55 .SH OPTIONS
56 This program follows the usual GNU command line syntax, with long options
57 starting with two dashes (`\-'). A summary of options is included below.
58 .TP
59 .B \-d,  \-\-display <string>
60 Attempt to open a window on the named X display. In the absence of  this option,
61 the  display  specified  by the
62 .B DISPLAY
63 environment variable is used.
64 .TP
65 .B \-bl, \-\-backlight
66 turn on back-light.
67 .TP
68 .B \-lc, \-\-light-color <color>
69 back-light color. (default: rgb:6E/C6/3B)
70 .TP
71 .B \-fg, \-\-foreground-color <color>
72 back-light color. (default: rgb:00/00/00)
73 .TP
74 .B \-bg, \-\-background-color <color>
75 back-light color. (default: rgb:8E/96/8A)
76 .TP
77 .B \-hc, \-\-highlight-color <color>
78 back-light color. (default: rgb:76/7C/6F)
79 .TP
80 .B \-mt, \-\-midtone-color <color>
81 back-light color. (default: rgb:44/44/44)
82 .TP
83 .B \-tc, \-\-theme-classic
84 Theme: use <= 0.5 style interface theme
85 .TP
86 .B \-tn, \-\-theme-new
87 Theme: use updated (new) theme
88 .TP
89 .B \-ts, \-\-theme-snow
90 Theme: use snow theme
91 .TP
92 .B \-i,  \-\-interval <integer>
93 sets update interval (in seconds)
94 .TP
95 .B \-h,  \-\-help
96 show help text and exit.
97 .TP
98 .B \-v,  \-\-version
99 show program version and exit.
101 .B \-w,  \-\-windowed
102 run the application in windowed mode
104 .B \-bw,  \-\-broken-wm
105 activate broken window manager fix
107 .B \-l,   \-\-learn
108 attempt max signal quality autodetection/learning for broken wireless drivers
109 (ndiswrapper, prism54).
110 *Note* this may break the max signal quality.
112 .B \\+s,   \-\-scroll-on
113 scroll the interface name and essid
115 .B \\-s,   \-\-scroll-off
116 use <= 0.5 style interface and essid (i.e. don't scroll)
119 .SH AUTHOR
120 wmwifi was written by Jess Mahan <jess@digitalssg.net>.
122 This manual page was written by Jess Mahan <jess@digitalssg.net>,
123 for the Debian GNU/Linux system (but may be used by others).