WiFi Radar
--------------------------------------------------------------------------------

    WiFi Radar is a Python/PyGTK2 utility for managing
    WiFi profiles on GNU/Linux.

    Maintained by Sean Robinson <robinson@tuxfamily.org>

    Created by Ahmad Baitalmal <ahmad@baitalmal.com>
    Previously maintained by Brian Elliott Finley <brian@thefinleys.com>

    http://wifi-radar.tuxfamily.org

    WiFi Radar is released under the GPL license.


Quick Usage
--------------------------------------------------------------------------------

    To show the GUI and manage profiles:

        sudo wifi-radar


I. Here are Some Important Bits:
--------------------------------------------------------------------------------

    * The config file defaults to /etc/wifi-radar/wifi-radar.conf.  The
      location of this file can be changed at install time with:

        "make install sysconfdir=/usr/local/etc/wifi-radar"

    * The configuration file format changed between v1.9.9 and v2.0.s01.
      The two formats are not compatible with each other.  If you are
      upgrading from v1.9.9, you will need to re-create your configuration.

    * If the config file does not exist, it will be created at run-time,
      so you must always invoke wifi-radar as root or with sudo.

    * You can change everything else from the config file which is simply
      a .ini-style file.

    If you have questions, check the WiFi Radar web site at
    http://wifi-radar.tuxfamily.org for a FAQ, a mailing
    list, and a user manual.  Any of which may have your answer.


II. Dependencies
--------------------------------------------------------------------------------

    * Python
    * PyGtk2
    * Wireless Tools for Linux (iwconfig, iwlist)
    * SpeechD (optional)


III. Install
--------------------------------------------------------------------------------

    1. Type "sudo make install"
       (or "sudo make install sysconfdir=/usr/local/etc/wifi-radar")


IV. HOWTO: Optional PAM Configuration
--------------------------------------------------------------------------------

    These instructions allow you to run wifi-radar as a normal user
    without using sudo.  Thanks to Flipp Bunts <flipp.bunts@gmail.com>
    for this HOWTO.

    HOWTO get wifi-radar custom launcher to use PAM authentication in
    Gnome:
        1. get wifi-radar and untar
        2. put wifi-radar.svg in /usr/share/pixmaps
        3. put wifi-radar.py in /usr/local/bin
        4. ln -s /usr/bin/consolehelper /usr/local/bin/wifi-radar
        5. vi /etc/security/console.apps/wifi-radar
                USER=root
                PROGRAM=/usr/local/bin/wifi-radar.py
                SESSION=true
        6. vi /etc/pam.d/wifi-radar
                #%PAM-1.0
                auth       sufficient   pam_rootok.so
                auth       sufficient   pam_timestamp.so
                auth       required     pam_stack.so service=system-auth
                session    required     pam_permit.so
                session    optional     pam_xauth.so
                session    optional     pam_timestamp.so
                account    required     pam_permit.so
        7. check the permissions
                # ls -lh /etc/security/console.apps/wifi-radar /etc/pam.d/wifi-radar
                -rw-r--r--  1 root root  /etc/pam.d/wifi-radar
                -rw-r--r--  1 root root  /etc/security/console.apps/wifi-radar
        8. add launcher
                a. right click on panel
                b. select 'add to panel'
                c. click on 'custom application launcher'
                d. options for 'create launcher'
                name : wifi-radar
                command : /usr/local/bin/wifi-radar
                icon : /usr/share/pixmap/wifi-radar.svg
        9. click on the icon, enter the root password, away you go


V. HOWTO: Environment Variables Set For Connect and Disconnect Scripts
--------------------------------------------------------------------------------

    The following environment variables are set for the pre- and post-
    scipts for connect and disconnect operations (i.e. all four user scripts):

        1. WIFIRADAR_IF is the network interface which is dis/connecting

    The following variables are set in the shell environment in
    which the post-connect and pre-disconnect scripts are executed.

        1. WIFIRADAR_IP is the current IP address
        2. WIFIRADAR_ESSID is the current ESSID
        3. WIFIRADAR_BSSID is the current BSSID


VI. HOWTO: Interpolated Strings in the Configuration File
--------------------------------------------------------------------------------

    It is possible to use configuration file options in the value of other
    options. An example:

        [DEFAULT]
        interface = wlan1

        [DHCP]
        pidfile = /etc/dhcpc/dhcpcd-%(interface)s.pid

    means that WiFi Radar will use the file /etc/dhcpc/dhcpcd-wlan1.pid for
    the DHCP PID file.

    These interpolated strings can be safely entered into preferences dialog text
    areas.


Have fun!
