wifi-radar.conf(5)						File Formats Manual						wifi-radar.conf(5)

NAME

       wifi-radar.conf - configuration file for WiFi Radar

SYNOPSIS

       wifi-radar.conf

DESCRIPTION

       wifi-radar.conf is the configuration file for WiFi Radar (wifi-radar(1)) a PyGTK2 utility for managing WiFi profiles in GNU/Linux.

       The  file  is an ini-type format with three global sections: [DEFAULT], [DHCP], and [WPA].  These are followed by zero or more profile sec-
       tions.

       The settings contained in the configuration file can all be edited from within WiFi Radar, either through the  Preferences  button  or  the
       Edit button.  But you are free to edit the configuration file manually if you like.

Interpolated Strings
       It  is  possible to use configuration options in the value of other options. To use interpolated strings, surround any option from the con-
       figuration file with %( and )s.	So, to use the interface option from the [DEFAULT] section in the value of any other option, use  %(inter-
       face)s in the option's value.

Global Settings
   [DEFAULT]
       General options.

       auto_profile_order
	   Comma-separated  list  of  profiles,  surrounded  by  square brackets, specifying the order of profiles in the main window.	An example
	   value: ['test:00:00:00:00:00:00', 'WinterPalace:']

	   (default: [])

       commit_required
	   Set to True if iwconfig(8) commit should be used after each iwconfig command.

	   (default: False)

       ifconfig_command
	   Specify the path to ifconfig(8), the command to use when manipulating the IP settings of the NIC.

	   (default: /sbin/ifconfig)

       ifup_required
	   Set to True if the NIC must be activated (i.e. ifconfig wlan0 up) before scanning will work.

	   (default: False)

       interface
	   Specifies the interface to scan. Set to the name of your NIC (e.g.  eth1 or wlan0). The special value 'auto_detect' will use the first-
	   found WiFi interface.

	   (default: auto_detect)

       iwconfig_command
	   Specify the path to iwconfig(8), the command to use when trying to associate with a network.

	   (default: /sbin/iwconfig)

       iwlist_command
	   Specify the path to iwlist(8), the command to use for scanning for access points.

	   (default: /sbin/iwlist)

       logfile
	   Sets the location of the log file.

	   (default: /var/log/wifi-radar.log)

       loglevel
	   This  sets  the  verbosity of messages sent to the logfile.	The number given here is a threshold value, only those messages emitted by
	   WiFi Radar which exceed loglevel will be written to the logfile.  The maximum (and default) value of 50 means to  only  save  the  most
	   critical messages and a loglevel of 0 means to save all messages to the logfile.

	   (default: 50)

       route_command
	   Specify the path to route(8), the command to use to set up network routing if DHCP is not used.

	   (default: /sbin/route)

       speak_command
	   Specify the path to the command to use to speak status messages.  This can be any program which takes a string on the command line.

	   (default: /usr/bin/say)

       speak_up
	   Set to True to use the speak command.

	   (default: False)

       version
	   The	version  of  WiFi Radar which created this configuration file. This value is overwritten by WiFi Radar each time the configuration
	   file is saved.

   [DHCP]
       Options for the DHCP client used by WiFi Radar.

       args
	   The parameters to pass to the DHCP client when acquiring a lease (i.e. setting up a connection).

	   (default: -D -o -i dhcp_client -t %(timeout)s)

       command
	   The command to use to automatically set up the IP networking.  This can be any DHCP client, like dhcpcd(8) or dhclient(8), which  forks
	   into the background or exits when it acquires an IP address or fails.

	   (default: /sbin/dhcpcd)

       kill_args
	   The parameters to pass to the DHCP client when disconnecting from a network.

	   (default: -k)

       pidfile
	   Specify  where  the	DHCP  client saves its state info.  This file is used if the standard DHCP disconnect does not work and WiFi Radar
	   must kill the client on its own.

	   (default: /etc/dhcpc/dhcpcd-%(interface)s.pid)

       timeout
	   The time (in seconds) to allow the DHCP client to try to acquire a lease.  If the DHCP client does not stop itself after this length of
	   time plus five seconds, WiFi Radar will force the client to end.

	   (default: 30)

   [WPA]
       Options for the WPA supplicant used by WiFi Radar.

       args
	   The parameters to pass to the WPA supplicant when associating with the network.

	   (default: -B -i %(interface)s -c %(configuration)s -D %(driver)s -P %(pidfile)s)

       command
	   Specify the command to use as the WPA supplicant.

	   (default: /usr/sbin/wpa_supplicant)

       configuration
	   The WPA supplicant's configuration file.

	   (default: /etc/wpa_supplicant.conf)

       driver
	   The WPA supplicant driver to use.

	   (default: wext)

       kill_command
	   The command to use to end the WPA supplicant.

	   The default is an empty value.

       pidfile
	   Specify where the WPA supplicant saves its state info.

	   (default: /var/run/wpa_supplicant.pid)

Per-profile Settings
       Each  profile  header  consists	of  the  network  name (a.k.a. ESSID), followed by a colon, and optionally followed by the network address
       (a.k.a. BSSID).	The BSSID may be blank if the profile is a roaming profile.  So a sample roaming profile  section  name  could	look  like
       [WinterPalace:].

       available
	   Used internally by WiFi Radar to indicate whether an access point is currently detected, it should always be False in the configuration
	   file.

	   (default: False)

       bssid
	   A copy of the BSSID in the section name, it is used to calculate the section name.  The  BSSID  is  the  network  address,  it  usually
	   matches the AP address.  It may be blank in a roaming profile.

	   (default: 00:00:00:00:00:00)

       channel
	   The channel to use to connect with the network.

	   (default: auto)

       con_postscript
	   The command to run after connecting to the network.

	   The default is an empty value.

       con_prescript
	   The command to run before connecting to the network.

	   The default is an empty value.

       dis_postscript
	   The command to run after disconnecting from the network.

	   The default is an empty value.

       dis_prescript
	   The command to run before disconnecting from the network.

	   The default is an empty value.

       dns1
	   The primary DNS server.  Part of the static configuration to use when not using DHCP.

	   The default is an empty value.

       dns2
	   The secondary DNS server.  Part of the static configuration to use when not using DHCP.

	   The default is an empty value.

       domain
	   The domain (e.g. winterpalace.org) of the network.  Part of the static configuration to use when not using DHCP.

	   The default is an empty value.

       encrypted
	   Whether  the  network is encrypted.	The value for this option is determined by scanning and will be overwritten if changed manually in
	   the configuration file.

	   (default: False)

       essid
	   The network name.  This is a copy of the ESSID in the section name and is used to calculate the section name.

	   The default is an empty value.

       gateway
	   The IP address of the gateway to other networks.  Part of the static configuration to use when not using DHCP.

	   The default is an empty value.

       ip  The fixed IP address to use on this network.  Part of the static configuration to use when not using DHCP.

	   The default is an empty value.

       key The WEP encryption key.  This is not used with WPA.

	   The default is an empty value.

       known
	   This is used internally by WiFi Radar to indicate whether an access point has a configured profile, it should always  be  True  in  the
	   configuration file.

	   (default: True)

       mode
	   This is the association mode to use.  This is not the same as the mode reported by the AP.  In fact, this should be a reflection of the
	   AP mode (i.e. Master mode AP should be Managed mode here).

	   (default: auto)

       netmask
	   The netmask (e.g. 192.168.1.0/255) to use.  Part of the static configuration to use when not using DHCP.

	   The default is an empty value.

       protocol
	   The WiFi protocol used by the access point (AP).  This is only used as a place to store the protocol read from the AP.   This  will	be
	   overwritten the next time the AP is scanned.

	   (default: g)

       roaming
	   Set to True if this is a roaming profile.

	   (default: False)

       security
	   This should/will be the security mode (i.e. open or restricted), but as it currently causes crashes, it is not used.

	   The default is an empty value.

       signal
	   The	signal	level read from the access point (AP).	This is used internally by WiFi Radar, the value will be overwritten each time the
	   configuration file is saved.

	   (default: 0)

       use_dhcp
	   When set to True, WiFi Radar will ask the DHCP client to configure the IP settings.

	   (default: True)

       use_wpa
	   When set to True, WiFi Radar will ask the WPA supplicant to handle associating with the access point.

	   (default: False)

       wpa_driver
	   The card driver the WPA supplicant should use.

	   The default is an empty value.

EXAMPLE

       [DEFAULT]
       auto_profile_order = ['test:00:00:00:00:00:00', 'WinterPalace:']
       commit_required = False
       ifconfig_command = /sbin/ifconfig
       ifup_required = True
       interface = auto_detect
       iwconfig_command = /sbin/iwconfig
       iwlist_command = /sbin/iwlist
       logfile = /var/log/wifi-radar.log
       loglevel = 50
       route_command = /sbin/route
       speak_command = /usr/bin/say
       speak_up = False
       version = 2.0.s02

       [DHCP]
       args = -D -o -i dhcp_client -t %(timeout)s
       command = /sbin/dhcpcd
       kill_args = -k
       pidfile = /etc/dhcpc/dhcpcd-%(interface)s.pid
       timeout = 30

       [WPA]
       args = -B -i %(interface)s -c %(configuration)s -D %(driver)s -P %(pidfile)s
       command = /usr/sbin/wpa_supplicant
       configuration = /etc/wpa_supplicant.conf
       driver = wext
       kill_command =
       pidfile = /var/run/wpa_supplicant.pid

       [test:00:00:00:00:00:00]
       available = False
       bssid = 00:00:00:00:00:00
       channel = auto
       con_postscript =
       con_prescript =
       dis_postscript =
       dis_prescript =
       dns1 =
       dns2 =
       domain =
       encrypted = False
       essid = test
       gateway =
       ip =
       key =
       known = True
       mode = auto
       netmask =
       protocol = g
       roaming = False
       security =
       signal = 0
       use_dhcp = True
       use_wpa = False
       wpa_driver =

       [WinterPalace:]
       available = False
       bssid =
       channel = auto
       con_postscript =
       con_prescript =
       dis_postscript =
       dis_prescript =
       dns1 =
       dns2 =
       domain =
       encrypted = True
       essid = WinterPalace
       gateway =
       ip =
       key = 123456789ABCDEF
       known = True
       mode = auto
       netmask =
       protocol = g
       roaming = True
       security =
       signal = 0
       use_dhcp = True
       use_wpa = False
       wpa_driver =

FILES

       /etc/wifi-radar/wifi-radar.conf

BUGS

       Probably lots!

SEE ALSO

       wifi-radar(1) wpa_supplicant.conf(5)

WiFi Radar 2.0							     July 2009							wifi-radar.conf(5)