aboutsummaryrefslogtreecommitdiffstats
path: root/wavemonrc.5
blob: e162fc8941c5a782cb10afe4fcc1fad81b26f9b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
.TH wavemonrc 5 "December 2018" Linux "User Manuals"
.SH NAME
$HOME/.wavemonrc \- wavemon configuration file
.SH DESCRIPTION
\fIwavemonrc\fR is the per-user configuration file for \fBwavemon\fR(1).
This page describes its individual configuration options.  Each corresponds
to a configuration item of the \fIPreferences\fR screen (F7 key), whose
on-screen name is shown in parentheses.
.P
.B interface = <ifname>
.RS
.RE
(Interface)
.RS
Selects the wireless interface to use.
.P
.RE
.B cisco_mac = (on|off)
.RS
.RE
(Cisco-style MAC addresses)
.RS
If enabled, display MAC addresses using lower-case hex digits separated by dots
rather than colons.
.P
.RE
.B sort_order = (channel|essid|mac|signal|open|chan/sig|open/sig)
.RS
.RE
(Scan sort type)
.RS
Determines the ordering used in the scan window: \fIchannel\fR sorts by channel number, \fIessid\fR by
access point name, \fImac\fR by MAC address, \fIsignal\fR by signal strength, and \fIopen\fR by openness.
The combined variants \fIchan/sig\fR and \fIopen/sig\fR sort first by channel/openness and then by signal strength.
It also affects the status line at the bottom: normally the most crowded channels are listed,
sorting by \fIchannel\fR in descending order switches to least crowded ones instead.
.P
.RE
.B sort_ascending = (on|off)
.RS
.RE
(Scan sort direction)
.RS
Sets the direction of the \fIsort_order\fR: ascending (on) or descending (off).
.P
.RE
.B stat_updates = <n>
.RS
.RE
(Statistics updates)
.RS
Time interval for polling new statistics (including scan refresh). Range: 10..4000ms.
.P
.RE
.B lhist_slot_size = <n>
.RS
.RE
(Histogram update cycles)
.RS
Number of samples used per each histogram slot. For example, if the stat_updates
interval is 500ms and the histogram slot size is 4, the histogram is moved
one slot further every 2 seconds. Range: 1..64.
.P
.RE
.B meter_smoothness = <n>
.RS
.RE
(Level meter smoothness)
.RS
Determines the responsiveness of level meters, tracking the moving average
rather than following each new sample. The given value specifies the percentage
of the history (the 'inertia') of preceding samples. A value of 0 disables
this option. Range: 0..99%.
.P
.RE
.B info_updates = <n>
.RS
.RE
(Dynamic info updates)
.RS
Sets refresh rate for dynamic device parameters (e.g. bitrate) and the
refresh interval for the Scan window (F3). Range: 1..60s.
.P
.RE
.B override_auto_scale = (on|off)
.RS
.RE
(Override scale autodetect)
.RS
Override the auto-scaling of the bar graphs and histogram, allowing you to set your own scales.
.P
.RE
.B min_signal_level, max_signal_level = <n>
.RS
.RE
(Minimum signal level, Maximum signal level)
.RS
Set the left and right boundaries of the signal level scales. Ranges: \-100..\-39 (minimum) and \-40..\-10dBm (maximum).
.P
.RE
.B min_noise_level, max_noise_level = <n>
.RS
.RE
(Minimum noise level, Maximum noise level)
.RS
These work similar to the signal boundary settings. Ranges: \-120..\-70dBm
(minimum) and \-69..\-40dBm (maximum).
.P
.RE
.B lo_threshold_action = (disabled|beep|flash|beep+flash)
.RS
.RE
(Low threshold action)
.RS
Issue a warning  at a given threshold at the lower end of the signal
scale. It is meant for alarming you when a signal appears at the receiver.
.P
.RE
.B lo_threshold = <n>
.RS
.RE
(Low threshold)
.RS
Sets the threshold value for the 'Low threshold action'.
Range: \-120..\-60dBm.
.P
.RE
.B hi_threshold_action = (disabled|beep|flash|beep+flash)
.RS
.RE
(High threshold action)
.RS
Analogous to lo_threshold_action, only this time the threshold is at
the upper end of the scale and the action is performed when the signal level
drops below it. The acoustic signal is also different in order to be easily
distinguishable from the lower one. Correctly adjusted, this little fellow
will tell you when you should move closer to the base station.
.P
.RE
.B hi_threshold = <n>
.RS
.RE
(High threshold)
.RS
Sets the threshold for the 'High threshold action'. Range: \-59..120dBm.
.P
.RE
.B transparent_bg = (on|off)
.RS
.RE
(Use transparent background)
.RS
If enabled, use a transparent background instead of black. This is
enabled by default and can only be turned off via the startup file.
.P
.RE
.B startup_screen = (info|histogram|scan window)
.RS
.RE
(Startup screen)
.RS
Which of the screens appears at program startup.
.SH "AUTHOR"
Written by Jan Morgenstern <jan@jm-music.de>.
.SH "REPORTING BUGS"
Send bug reports and/or suggestions to Gerrit Renker <gerrit@erg.abdn.ac.uk>.
.SH "COPYRIGHT"
This is free software with ABSOLUTELY NO WARRANTY. See file COPYING for details.