| blob | 40741aae1a9b8b1d1e91726bc4f84b434570df42 |
1 .\" Author: Sean Robinson <robinson@tuxfamily.org>
2 .\" Copyright 2009,2014 by Sean Robinson
3 .\" Made available under the Creative Commons Attribution License 3.0
4 .\" -----------------------------------------------------------------
5 .
6 .TH wifi-radar.conf 5 "July 2009" "WiFi Radar 2.0"
7 .
8 .SH NAME
9 .
10 wifi-radar.conf \- configuration file for WiFi Radar
11 .
12 .SH SYNOPSIS
13 .
14 .B wifi-radar.conf
15 .
16 .SH DESCRIPTION
17 .
18 wifi-radar.conf is the configuration file for
19 .B WiFi Radar
20 .I (wifi-radar(1))
21 a PyGTK2 utility for managing WiFi profiles in
22 GNU/Linux.
23 .PP
24 The file is an ini-type format with three global sections:
25 .B [DEFAULT], [DHCP],
26 and
27 .B [WPA].
28 These are followed by
29 zero or more profile sections.
30 .PP
31 The settings contained in the configuration file can all be edited
32 from within
33 .B WiFi Radar,
34 either through the
35 .B Preferences button
36 or the
37 .B Edit button.
38 But you are free to edit the configuration file manually if you like.
39 .
40 .SH Interpolated Strings
41 .
42 It is possible to use configuration options in the value of other
43 options. To use interpolated strings, surround any option from the
44 configuration file with
45 .B %(
46 and
47 .B )s.
48 So, to use the
49 .I interface
50 option from the
51 .B [DEFAULT]
52 section in the value of any other option, use
53 \fB%(\fIinterface\fB)s\fR
54 in the option's value.
55 .
56 .SH Global Settings
57 .
58 .SS [DEFAULT]
59 General options.
60 .
61 .TP 4
62 .B auto_profile_order
63 Comma-separated list of profiles, surrounded by square brackets,
64 specifying the order of profiles in the main window. An example value:
65 ['test:00:00:00:00:00:00', 'WinterPalace:']
66 .IP
67 .B (default: [])
68 .
69 .TP 4
70 .B commit_required
71 Set to
72 .B True
73 if
74 .I iwconfig(8)
75 commit should be used after each iwconfig command.
76 .IP
77 .B (default: False)
78 .
79 .TP 4
80 .B ifconfig_command
81 Specify the path to
82 .I ifconfig(8),
83 the command to use when manipulating the IP settings of the NIC.
84 .IP
85 .B (default: /sbin/ifconfig)
86 .
87 .TP 4
88 .B ifup_required
89 Set to
90 .B True
91 if the NIC must be activated (i.e. ifconfig wlan0 up) before scanning
92 will work.
93 .IP
94 .B (default: False)
95 .
96 .TP 4
97 .B interface
98 Specifies the interface to scan. Set to the name of your NIC (e.g.
99 eth1 or wlan0). The special value 'auto_detect' will use the
100 first-found WiFi interface.
101 .IP
102 .B (default: auto_detect)
104 .TP 4
105 .B iwconfig_command
106 Specify the path to
107 .I iwconfig(8),
108 the command to use when trying to associate with a network.
109 .IP
110 .B (default: /sbin/iwconfig)
111 .
112 .TP 4
113 .B iwlist_command
114 Specify the path to
115 .I iwlist(8),
116 the command to use for scanning for access points.
117 .IP
118 .B (default: /sbin/iwlist)
119 .
120 .TP 4
121 .B logfile
122 Sets the location of the log file.
123 .IP
124 .B (default: /var/log/wifi-radar.log)
125 .
126 .TP 4
127 .B loglevel
128 This sets the verbosity of messages sent to the logfile. The number
129 given here is a threshold value, only those messages emitted by
130 .B WiFi Radar
131 which exceed loglevel will be written to the logfile. The maximum
132 (and default) value of 50 means to only save the most critical
133 messages and a loglevel of 0 means to save all messages to the
134 logfile.
135 .IP
136 .B (default: 50)
137 .
138 .TP 4
139 .B route_command
140 Specify the path to
141 .I route(8),
142 the command to use to set up network routing if DHCP is not used.
143 .IP
144 .B (default: /sbin/route)
145 .
146 .TP 4
147 .B speak_command
148 Specify the path to the command to use to speak status messages.
149 This can be any program which takes a string on the command line.
150 .IP
151 .B (default: /usr/bin/say)
152 .
153 .TP 4
154 .B speak_up
155 Set to
156 .B True
157 to use the speak command.
158 .IP
159 .B (default: False)
160 .
161 .TP 4
162 .B version
163 The version of
164 .B WiFi Radar
165 which created this configuration file. This value is overwritten by
166 .B WiFi Radar
167 each time the configuration file is saved.
168 .
169 .SS [DHCP]
170 Options for the DHCP client used by
171 .B WiFi Radar.
172 .
173 .TP 4
174 .B args
175 The parameters to pass to the DHCP client when acquiring a lease
176 (i.e. setting up a connection).
177 .IP
178 .B (default: -D -o -i dhcp_client -t %(timeout)s)
179 .
180 .TP 4
181 .B command
182 The command to use to automatically set up the IP networking. This
183 can be any DHCP client, like
184 .I dhcpcd(8)
185 or
186 .I dhclient(8),
187 which forks into the background or exits when it acquires an IP address
188 or fails.
189 .IP
190 .B (default: /sbin/dhcpcd)
191 .
192 .TP 4
193 .B kill_args
194 The parameters to pass to the DHCP client when disconnecting from a
195 network.
196 .IP
197 .B (default: -k)
198 .
199 .TP 4
200 .B pidfile
201 Specify where the DHCP client saves its state info. This file is
202 used if the standard DHCP disconnect does not work and
203 .B WiFi Radar
204 must kill the client on its own.
205 .IP
206 .B (default: /etc/dhcpc/dhcpcd-%(interface)s.pid)
207 .
208 .TP 4
209 .B timeout
210 The time (in seconds) to allow the DHCP client to try to acquire a
211 lease. If the DHCP client does not stop itself after this length of
212 time plus five seconds,
213 .B WiFi Radar
214 will force the client to end.
215 .IP
216 .B (default: 30)
217 .
218 .SS [WPA]
219 Options for the WPA supplicant used by
220 .B WiFi Radar.
221 .
222 .TP 4
223 .B args
224 The parameters to pass to the WPA supplicant when associating with the
225 network.
226 .IP
227 .B (default: -B -i %(interface)s -c %(configuration)s -D %(driver)s -P %(pidfile)s)
228 .
229 .TP 4
230 .B command
231 Specify the command to use as the WPA supplicant.
232 .IP
233 .B (default: /usr/sbin/wpa_supplicant)
234 .
235 .TP 4
236 .B configuration
237 The WPA supplicant's configuration file.
238 .IP
239 .B (default: /etc/wpa_supplicant.conf)
240 .
241 .TP 4
242 .B driver
243 The WPA supplicant driver to use.
244 .IP
245 .B (default: wext)
246 .
247 .TP 4
248 .B kill_command
249 The command to use to end the WPA supplicant.
250 .IP
251 .B The default is an empty value.
252 .
253 .TP 4
254 .B pidfile
255 Specify where the WPA supplicant saves its state info.
256 .IP
257 .B (default: /var/run/wpa_supplicant.pid)
258 .
259 .SH Per-profile Settings
260 Each profile header consists of the network name (a.k.a. ESSID),
261 followed by a colon, and optionally followed by the network address
262 (a.k.a. BSSID). The BSSID may be blank if the profile is a roaming
263 profile. So a sample roaming profile section name could look like
264 [WinterPalace:].
265 .
266 .TP 4
267 .B available
268 Used internally by
269 .B WiFi Radar
270 to indicate whether an access point is currently detected, it should
271 always be False in the configuration file.
272 .IP
273 .B (default: False)
274 .
275 .TP 4
276 .B bssid
277 A copy of the BSSID in the section name, it is used to calculate the
278 section name. The BSSID is the network address, it usually matches the
279 AP address. It may be blank in a roaming profile.
280 .IP
281 .B (default: 00:00:00:00:00:00)
282 .
283 .TP 4
284 .B channel
285 The channel to use to connect with the network.
286 .IP
287 .B (default: auto)
288 .
289 .TP 4
290 .B con_postscript
291 The command to run after connecting to the network.
292 .IP
293 .B The default is an empty value.
294 .
295 .TP 4
296 .B con_prescript
297 The command to run before connecting to the network.
298 .IP
299 .B The default is an empty value.
300 .
301 .TP 4
302 .B dis_postscript
303 The command to run after disconnecting from the network.
304 .IP
305 .B The default is an empty value.
306 .
307 .TP 4
308 .B dis_prescript
309 The command to run before disconnecting from the network.
310 .IP
311 .B The default is an empty value.
312 .
313 .TP 4
314 .B dns1
315 The primary DNS server. Part of the static configuration to use when
316 not using DHCP.
317 .IP
318 .B The default is an empty value.
319 .
320 .TP 4
321 .B dns2
322 The secondary DNS server. Part of the static configuration to use when
323 not using DHCP.
324 .IP
325 .B The default is an empty value.
326 .
327 .TP 4
328 .B domain
329 The domain (e.g. winterpalace.org) of the network. Part of the static
330 configuration to use when not using DHCP.
331 .IP
332 .B The default is an empty value.
333 .
334 .TP 4
335 .B encrypted
336 Whether the network is encrypted. The value for this option is
337 determined by scanning and will be overwritten if changed manually in
338 the configuration file.
339 .IP
340 .B (default: False)
341 .
342 .TP 4
343 .B essid
344 The network name. This is a copy of the ESSID in the section name and
345 is used to calculate the section name.
346 .IP
347 .B The default is an empty value.
348 .
349 .TP 4
350 .B gateway
351 The IP address of the gateway to other networks. Part of the static
352 configuration to use when not using DHCP.
353 .IP
354 .B The default is an empty value.
355 .
356 .TP 4
357 .B ip
358 The fixed IP address to use on this network. Part of the static
359 configuration to use when not using DHCP.
360 .IP
361 .B The default is an empty value.
362 .
363 .TP 4
364 .B key
365 The WEP encryption key. This is not used with WPA.
366 .IP
367 .B The default is an empty value.
368 .
369 .TP 4
370 .B known
371 This is used internally by
372 .B WiFi Radar
373 to indicate whether an access point has a configured profile, it
374 should always be True in the configuration file.
375 .IP
376 .B (default: True)
377 .
378 .TP 4
379 .B mode
380 This is the association mode to use. This is not the same as the mode
381 reported by the AP. In fact, this should be a reflection of the AP
382 mode (i.e. Master mode AP should be Managed mode here).
383 .IP
384 .B (default: auto)
385 .
386 .TP 4
387 .B netmask
388 The netmask (e.g. 192.168.1.0/255) to use. Part of the static
389 configuration to use when not using DHCP.
390 .IP
391 .B The default is an empty value.
392 .
393 .TP 4
394 .B protocol
395 The WiFi protocol used by the access point (AP). This is only used as
396 a place to store the protocol read from the AP. This will be
397 overwritten the next time the AP is scanned.
398 .IP
399 .B (default: g)
400 .
401 .TP 4
402 .B roaming
403 Set to True if this is a roaming profile.
404 .IP
405 .B (default: False)
406 .
407 .TP 4
408 .B security
409 This should/will be the security mode (i.e. open or restricted), but
410 as it currently causes crashes, it is not used.
411 .IP
412 .B The default is an empty value.
413 .
414 .TP 4
415 .B signal
416 The signal level read from the access point (AP). This is used
417 internally by
418 .B WiFi Radar,
419 the value will be overwritten each time the configuration file is saved.
420 .IP
421 .B (default: 0)
422 .
423 .TP 4
424 .B use_dhcp
425 When set to True,
426 .B WiFi Radar
427 will ask the DHCP client to configure the IP settings.
428 .IP
429 .B (default: True)
430 .
431 .TP 4
432 .B use_wpa
433 When set to True,
434 .B WiFi Radar
435 will ask the WPA supplicant to handle associating with the access point.
436 .IP
437 .B (default: False)
438 .
439 .TP 4
440 .B wpa_driver
441 The card driver the WPA supplicant should use.
442 .IP
443 .B The default is an empty value.
444 .
445 .SH EXAMPLE
446 .
447 .nf
448 [DEFAULT]
449 auto_profile_order = ['test:00:00:00:00:00:00', 'WinterPalace:']
450 commit_required = False
451 ifconfig_command = /sbin/ifconfig
452 ifup_required = True
453 interface = auto_detect
454 iwconfig_command = /sbin/iwconfig
455 iwlist_command = /sbin/iwlist
456 logfile = /var/log/wifi-radar.log
457 loglevel = 50
458 route_command = /sbin/route
459 speak_command = /usr/bin/say
460 speak_up = False
461 version = 2.0.s02
462 .PP
463 [DHCP]
464 args = -D -o -i dhcp_client -t %(timeout)s
465 command = /sbin/dhcpcd
466 kill_args = -k
467 pidfile = /etc/dhcpc/dhcpcd-%(interface)s.pid
468 timeout = 30
469 .PP
470 [WPA]
471 args = -B -i %(interface)s -c %(configuration)s -D %(driver)s -P %(pidfile)s
472 command = /usr/sbin/wpa_supplicant
473 configuration = /etc/wpa_supplicant.conf
474 driver = wext
475 kill_command =
476 pidfile = /var/run/wpa_supplicant.pid
477 .PP
478 [test:00:00:00:00:00:00]
479 available = False
480 bssid = 00:00:00:00:00:00
481 channel = auto
482 con_postscript =
483 con_prescript =
484 dis_postscript =
485 dis_prescript =
486 dns1 =
487 dns2 =
488 domain =
489 encrypted = False
490 essid = test
491 gateway =
492 ip =
493 key =
494 known = True
495 mode = auto
496 netmask =
497 protocol = g
498 roaming = False
499 security =
500 signal = 0
501 use_dhcp = True
502 use_wpa = False
503 wpa_driver =
504 .PP
505 [WinterPalace:]
506 available = False
507 bssid =
508 channel = auto
509 con_postscript =
510 con_prescript =
511 dis_postscript =
512 dis_prescript =
513 dns1 =
514 dns2 =
515 domain =
516 encrypted = True
517 essid = WinterPalace
518 gateway =
519 ip =
520 key = 123456789ABCDEF
521 known = True
522 mode = auto
523 netmask =
524 protocol = g
525 roaming = True
526 security =
527 signal = 0
528 use_dhcp = True
529 use_wpa = False
530 wpa_driver =
531 .
532 .SH FILES
533 .
534 .TP 8
535 .B /etc/wifi-radar/wifi-radar.conf
536 .
537 .SH BUGS
538 .
539 Probably lots!
540 .
541 .SH SEE ALSO
542 .
543 .I wifi-radar(1)
544 .I wpa_supplicant.conf(5)
545 .