wifi-radar.conf(5)

1wifi-radar.conf(5)            File Formats Manual           wifi-radar.conf(5)
2
3
4

NAME

6       wifi-radar.conf - configuration file for WiFi Radar
7

SYNOPSIS

9       wifi-radar.conf
10

DESCRIPTION

12       wifi-radar.conf  is  the  configuration  file  for  WiFi  Radar  (wifi-
13       radar(1)) a PyGTK2 utility for managing WiFi profiles in GNU/Linux.
14
15       The file is an ini-type format with three global  sections:  [DEFAULT],
16       [DHCP],  and  [WPA].   These  are followed by zero or more profile sec‐
17       tions.
18
19       The settings contained in the configuration file can all be edited from
20       within  WiFi  Radar,  either through the Preferences button or the Edit
21       button.  But you are free to edit the configuration  file  manually  if
22       you like.
23

Interpolated Strings

25       It  is  possible  to  use  configuration  options in the value of other
26       options. To use interpolated strings, surround any option from the con‐
27       figuration  file  with %( and )s.  So, to use the interface option from
28       the [DEFAULT] section in the value of any other  option,  use  %(inter‐
29       face)s in the option's value.
30

Global Settings

32   [DEFAULT]
33       General options.
34
35       auto_profile_order
36           Comma-separated  list  of  profiles, surrounded by square brackets,
37           specifying the order of profiles in the main  window.   An  example
38           value: ['test:00:00:00:00:00:00', 'WinterPalace:']
39
40           (default: [])
41
42       commit_required
43           Set  to True if iwconfig(8) commit should be used after each iwcon‐
44           fig command.
45
46           (default: False)
47
48       ifconfig_command
49           Specify the path to ifconfig(8), the command to use when manipulat‐
50           ing the IP settings of the NIC.
51
52           (default: /sbin/ifconfig)
53
54       ifup_required
55           Set  to  True if the NIC must be activated (i.e. ifconfig wlan0 up)
56           before scanning will work.
57
58           (default: False)
59
60       interface
61           Specifies the interface to scan. Set to the name of your NIC  (e.g.
62           eth1 or wlan0). The special value 'auto_detect' will use the first-
63           found WiFi interface.
64
65           (default: auto_detect)
66
67
68       iwconfig_command
69           Specify the path to iwconfig(8), the command to use when trying  to
70           associate with a network.
71
72           (default: /sbin/iwconfig)
73
74       iwlist_command
75           Specify  the path to iwlist(8), the command to use for scanning for
76           access points.
77
78           (default: /sbin/iwlist)
79
80       logfile
81           Sets the location of the log file.
82
83           (default: /var/log/wifi-radar.log)
84
85       loglevel
86           This sets the verbosity of messages sent to the logfile.  The  num‐
87           ber given here is a threshold value, only those messages emitted by
88           WiFi Radar which exceed loglevel will be written  to  the  logfile.
89           The  maximum  (and default) value of 50 means to only save the most
90           critical messages and a loglevel of 0 means to save all messages to
91           the logfile.
92
93           (default: 50)
94
95       route_command
96           Specify  the path to route(8), the command to use to set up network
97           routing if DHCP is not used.
98
99           (default: /sbin/route)
100
101       speak_command
102           Specify the path to the command to use to  speak  status  messages.
103           This can be any program which takes a string on the command line.
104
105           (default: /usr/bin/say)
106
107       speak_up
108           Set to True to use the speak command.
109
110           (default: False)
111
112       version
113           The  version  of  WiFi Radar which created this configuration file.
114           This value is overwritten by WiFi Radar each time the configuration
115           file is saved.
116
117   [DHCP]
118       Options for the DHCP client used by WiFi Radar.
119
120       args
121           The  parameters  to  pass to the DHCP client when acquiring a lease
122           (i.e. setting up a connection).
123
124           (default: -D -o -i dhcp_client -t %(timeout)s)
125
126       command
127           The command to use to automatically set up the IP networking.  This
128           can  be any DHCP client, like dhcpcd(8) or dhclient(8), which forks
129           into the background or exits when it  acquires  an  IP  address  or
130           fails.
131
132           (default: /sbin/dhcpcd)
133
134       kill_args
135           The parameters to pass to the DHCP client when disconnecting from a
136           network.
137
138           (default: -k)
139
140       pidfile
141           Specify where the DHCP client saves its state info.  This  file  is
142           used  if  the standard DHCP disconnect does not work and WiFi Radar
143           must kill the client on its own.
144
145           (default: /etc/dhcpc/dhcpcd-%(interface)s.pid)
146
147       timeout
148           The time (in seconds) to allow the DHCP client to try to acquire  a
149           lease.   If  the DHCP client does not stop itself after this length
150           of time plus five seconds, WiFi Radar will force the client to end.
151
152           (default: 30)
153
154   [WPA]
155       Options for the WPA supplicant used by WiFi Radar.
156
157       args
158           The parameters to pass to the WPA supplicant when associating  with
159           the network.
160
161           (default: -B -i %(interface)s -c %(configuration)s -D %(driver)s -P
162           %(pidfile)s)
163
164       command
165           Specify the command to use as the WPA supplicant.
166
167           (default: /usr/sbin/wpa_supplicant)
168
169       configuration
170           The WPA supplicant's configuration file.
171
172           (default: /etc/wpa_supplicant.conf)
173
174       driver
175           The WPA supplicant driver to use.
176
177           (default: wext)
178
179       kill_command
180           The command to use to end the WPA supplicant.
181
182           The default is an empty value.
183
184       pidfile
185           Specify where the WPA supplicant saves its state info.
186
187           (default: /var/run/wpa_supplicant.pid)
188

Per-profile Settings

190       Each profile header consists of the network name (a.k.a.  ESSID),  fol‐
191       lowed  by  a  colon,  and  optionally  followed  by the network address
192       (a.k.a. BSSID).  The BSSID may be blank if the  profile  is  a  roaming
193       profile.   So  a  sample  roaming  profile section name could look like
194       [WinterPalace:].
195
196       available
197           Used internally by WiFi Radar to indicate whether an  access  point
198           is  currently detected, it should always be False in the configura‐
199           tion file.
200
201           (default: False)
202
203       bssid
204           A copy of the BSSID in the section name, it is  used  to  calculate
205           the  section  name.   The  BSSID is the network address, it usually
206           matches the AP address.  It may be blank in a roaming profile.
207
208           (default: 00:00:00:00:00:00)
209
210       channel
211           The channel to use to connect with the network.
212
213           (default: auto)
214
215       con_postscript
216           The command to run after connecting to the network.
217
218           The default is an empty value.
219
220       con_prescript
221           The command to run before connecting to the network.
222
223           The default is an empty value.
224
225       dis_postscript
226           The command to run after disconnecting from the network.
227
228           The default is an empty value.
229
230       dis_prescript
231           The command to run before disconnecting from the network.
232
233           The default is an empty value.
234
235       dns1
236           The primary DNS server.  Part of the static  configuration  to  use
237           when not using DHCP.
238
239           The default is an empty value.
240
241       dns2
242           The  secondary DNS server.  Part of the static configuration to use
243           when not using DHCP.
244
245           The default is an empty value.
246
247       domain
248           The domain (e.g. winterpalace.org) of the  network.   Part  of  the
249           static configuration to use when not using DHCP.
250
251           The default is an empty value.
252
253       encrypted
254           Whether  the  network  is  encrypted.  The value for this option is
255           determined by scanning and will be overwritten if changed  manually
256           in the configuration file.
257
258           (default: False)
259
260       essid
261           The  network name.  This is a copy of the ESSID in the section name
262           and is used to calculate the section name.
263
264           The default is an empty value.
265
266       gateway
267           The IP address of the gateway  to  other  networks.   Part  of  the
268           static configuration to use when not using DHCP.
269
270           The default is an empty value.
271
272       ip  The  fixed  IP  address to use on this network.  Part of the static
273           configuration to use when not using DHCP.
274
275           The default is an empty value.
276
277       key The WEP encryption key.  This is not used with WPA.
278
279           The default is an empty value.
280
281       known
282           This is used internally by WiFi Radar to indicate whether an access
283           point  has  a  configured  profile, it should always be True in the
284           configuration file.
285
286           (default: True)
287
288       mode
289           This is the association mode to use.  This is not the same  as  the
290           mode  reported  by the AP.  In fact, this should be a reflection of
291           the AP mode (i.e. Master mode AP should be Managed mode here).
292
293           (default: auto)
294
295       netmask
296           The netmask (e.g. 192.168.1.0/255) to use.  Part of the static con‐
297           figuration to use when not using DHCP.
298
299           The default is an empty value.
300
301       protocol
302           The WiFi protocol used by the access point (AP).  This is only used
303           as a place to store the protocol read from the AP.   This  will  be
304           overwritten the next time the AP is scanned.
305
306           (default: g)
307
308       roaming
309           Set to True if this is a roaming profile.
310
311           (default: False)
312
313       security
314           This  should/will  be  the security mode (i.e. open or restricted),
315           but as it currently causes crashes, it is not used.
316
317           The default is an empty value.
318
319       signal
320           The signal level read from the access point  (AP).   This  is  used
321           internally  by  WiFi Radar, the value will be overwritten each time
322           the configuration file is saved.
323
324           (default: 0)
325
326       use_dhcp
327           When set to True, WiFi Radar will ask the DHCP client to  configure
328           the IP settings.
329
330           (default: True)
331
332       use_wpa
333           When  set to True, WiFi Radar will ask the WPA supplicant to handle
334           associating with the access point.
335
336           (default: False)
337
338       wpa_driver
339           The card driver the WPA supplicant should use.
340
341           The default is an empty value.
342

EXAMPLE

344       [DEFAULT]
345       auto_profile_order = ['test:00:00:00:00:00:00', 'WinterPalace:']
346       commit_required = False
347       ifconfig_command = /sbin/ifconfig
348       ifup_required = True
349       interface = auto_detect
350       iwconfig_command = /sbin/iwconfig
351       iwlist_command = /sbin/iwlist
352       logfile = /var/log/wifi-radar.log
353       loglevel = 50
354       route_command = /sbin/route
355       speak_command = /usr/bin/say
356       speak_up = False
357       version = 2.0.s02
358
359       [DHCP]
360       args = -D -o -i dhcp_client -t %(timeout)s
361       command = /sbin/dhcpcd
362       kill_args = -k
363       pidfile = /etc/dhcpc/dhcpcd-%(interface)s.pid
364       timeout = 30
365
366       [WPA]
367       args = -B -i %(interface)s -c %(configuration)s -D %(driver)s -P %(pidfile)s
368       command = /usr/sbin/wpa_supplicant
369       configuration = /etc/wpa_supplicant.conf
370       driver = wext
371       kill_command =
372       pidfile = /var/run/wpa_supplicant.pid
373
374       [test:00:00:00:00:00:00]
375       available = False
376       bssid = 00:00:00:00:00:00
377       channel = auto
378       con_postscript =
379       con_prescript =
380       dis_postscript =
381       dis_prescript =
382       dns1 =
383       dns2 =
384       domain =
385       encrypted = False
386       essid = test
387       gateway =
388       ip =
389       key =
390       known = True
391       mode = auto
392       netmask =
393       protocol = g
394       roaming = False
395       security =
396       signal = 0
397       use_dhcp = True
398       use_wpa = False
399       wpa_driver =
400
401       [WinterPalace:]
402       available = False
403       bssid =
404       channel = auto
405       con_postscript =
406       con_prescript =
407       dis_postscript =
408       dis_prescript =
409       dns1 =
410       dns2 =
411       domain =
412       encrypted = True
413       essid = WinterPalace
414       gateway =
415       ip =
416       key = 123456789ABCDEF
417       known = True
418       mode = auto
419       netmask =
420       protocol = g
421       roaming = True
422       security =
423       signal = 0
424       use_dhcp = True
425       use_wpa = False
426       wpa_driver =
427

FILES

429       /etc/wifi-radar/wifi-radar.conf
430

BUGS

432       Probably lots!
433