.\" Author: by Ahmad Baitalmal <ahmad@baitalmal.com>
.TH wifi-radar.conf 8 "April 2005"
.SH NAME
wifi-radar.conf \- utility for managing WiFi profiles
.SH DESCRIPTION
.PP
wifi-radar.conf is the configuration file for
.BI wifi-radar (1),
a PyGTK2 utility for managing WiFi profiles.
.PP
The configuration file uses
.B ini
file syntax, with sections labelled in square brackets.
The first section should be named
.BR [DEFAULT] ;
subsequent sections each name a particular configuration,
and can have any label.
They can override any non-global setting in the
.B [DEFAULT]
section.
.SH Global settings
.PP
The following settings are global,
and can only be specified in the
.B [GLOBAL]
section.
.TP 8
.B interface
Specifies the interface to scan.
If omitted, scans all interfaces.
.TP 8
.B scan_timeout
The number of seconds to allow for a scan;
if the time is exceeded,
and no access point was found,
the wireless network remains down.
.TP 8
.B commit_required
Set to
.B true
if your network card requires a "commit" command with
.BI iwconfig (8)
before the configuration is activated.
.TP 8
.B ifup_required
Set to
.B true
if your network card requires the interface to be brought up
before it can attach to an access point.
.TP 8
.B speak_up
Set to
.B true
if you wish to run the "say_command"
when you successfully connect to a network.
.TP 8
.B say_command
Set to a command to run if you wish to use the
.B speak_up
facility.
The default is "say"
(which runs a text-to-speech synthesizer on some systems)
but it can be set to any command.
The command is run with one of the following strings as its argument:
.IP
No preferred network found
.IP
Connecting to the <SSID> network
.IP
Unknown SSID
.IP
Disconnecting
.TP 8
.B auto_profile_order
Comma-separated list of ESSIDs (and thus, corresponding profiles)
to attempt to connect to automatically if found.
.SH Per-profile settings
.PP
The following settings can be set
in a profile section,
and override any corresponding
.B [GLOBAL]
setting in that configuration.
.PP
The label of the profile
must be the corresponding network's ESSID.
.TP 8
.B key
The network key for connecting to a secure network.
.TP 8
.B mode
The WiFi mode of the network; one of
(empty),
.BR "auto" ,
.BR "managed" ,
.BR "ad-hoc" ,
.BR "master" ,
.BR "repeater" ,
.BR "secondary" ,
or
.BR "monitor" .
.\" FIXME: what is the significance of this?
.TP 8
.B security
The security setting of the network; one of
(empty),
.BR open ,
or
.BR restricted .
.\" FIXME: what is the significance of this?
.TP 8
.B prescript
The name of a command or script to run
prior to connecting to the network.
The command is run if the network is found,
before any connection is attempted.
.TP 8
.B postscript
The name of a command or script to run
upon successfully connecting to the network.
.\" .TP 8
.\" .B channel
.\" The channel to use.
.\" See the
.\" .B wifi-tools
.\" documentation.
.\" .TP 8
.\" .B signal
.TP 8
.B protocol
The 801.11 protocol to use;
one of
.BR a ,
.BR b ,
or 
.BR g .
.TP 8
.B use_wpa
Set to
.B yes
to use WPA authentication.
.TP 8
.B wpa_driver
Name of the WPA driver to use.
Defaults to
.BR ipw .
.TP 8
.B use_dhcp
Set to
.B true
to dynamically obtain IP address, gateway, etc
from a DHCP server.
.TP 8
.B ip
Configure a static IP address.
.TP 8
.B netmask
Configure a static netmask.
.TP 8
.B gateway
Configure a static gateway.
.TP 8
.B domain
Configure a static domain name.
.TP 8
.B dns1
Configure a static DNS server.
.TP 8
.B dns2
Configure another static DNS server.
.SH EXAMPLES
.TP 16
Here is a sample configuration file using some features.
.PP
.nf
[DEFAULT]
ifup_required = False
auto_profile_order = BRTRY25TYU,WIFI_INED_RECHERCHE,WIFI_INED,any
speak_up = False
scan_timeout = 5
interface = eth1
commit_required = False

[BRTRY25TYU]
mode = 
key = e06de61003
use_dhcp = yes
security = 
channel = 

[WIFI_INED]
use_dhcp = yes

[WIFI_INED_RECHERCHE]
use_wpa = yes
mode = Auto
use_dhcp = yes
wpa_driver = ipw

[any]
key = 
use_dhcp = yes
.fi
.SH SEE ALSO
.PP
.BR wifi-radar (1)
.PP
.BR wpa_supplicant.conf (5)