From 6ca2a190a18f5b91735a271ef4e244dec4b27f4f Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 13 Aug 2003 17:08:52 +0000 Subject: doc update git-svn-id: file:///home/lennart/svn/public/aeswepd/trunk@7 022f378f-78c4-0310-b860-d162c87e6274 --- Makefile.am | 4 ++-- doc/README | 46 ++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 42 insertions(+), 8 deletions(-) diff --git a/Makefile.am b/Makefile.am index a9be40e..0746b0a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -31,5 +31,5 @@ homepage: test -d $$HOME/homepage/lennart mkdir -p $$HOME/homepage/lennart/projects/waproamd cp *.tar.gz $$HOME/homepage/lennart/projects/waproamd - cp doc/README.html doc/style.css doc/NEWS $$HOME/homepage/lennart/projects/waproamd - cp $$HOME/homepage/lennart/projects/waproamd/README.html $$HOME/homepage/lennart/projects/waproamd/index.html + cp doc/README $$HOME/homepage/lennart/projects/waproamd + #cp $$HOME/homepage/lennart/projects/waproamd/README.html $$HOME/homepage/lennart/projects/waproamd/index.html diff --git a/doc/README b/doc/README index 9c61633..32c40d3 100644 --- a/doc/README +++ b/doc/README @@ -2,18 +2,52 @@ Sorry, no real README yet. Just a short intro: +What is it? waproamd is an Linux WLAN roaming daemon for IEEE 802.11b cards +supported by a driver with wireless extension API. It may be used for +configuring WEP keys according to the WLANs available. It is intended +to be used in conjunction with ifplugd, which configures your network +automatically whenever a an association with an AP suceeded. + waproamd is to be used together with ifplugd. -waproamd: when not associated waproamd does periodic scans and tries to associate to a sensible AP by running a script in /etc/waproamd/scripts +waproamd: when not associated waproamd does periodic scans and tries +to associate to a sensible AP by running a script in +/etc/waproamd/scripts + +aeswepd: A daemon for doing AES based WEP rekeying, it is called by +/etc/waproamd/scripts/default if +/etc/waproamd/keys/[AP-MAC-ADDRESS].aes exists. It implements an +algorithm which is not standardized and only compatible with APs using +aeswepd as well. aeswepd may be used without waproamd. + +ifplugd: if an association succeeded ifplugd runs ifup for the device + +waproamd will not issue scans while associated. + +The algorithm to select an AP if multiple are available is rather +simple: The first AP which has a script named by the AP MAC address +available in /etc/waproamd/scripts/ is seleted. If none has suh a +script /etc/waproamd/scripts/default is run for the first AP. + +waproamd requires libdaemon. -aeswepd: A daemon for doing AES based WEP rekeying, is called by /etc/waproamd/scripts/default if /etc/waproamd/keys/foo.aes exists +waproamd is tested with hostap 0.0.3 only, with other drivers +ymmv. The host roaming feature of newer hostap releases might be +useful, however it is broken on 0.0.3 and not required by waproamd. -ifplugd: if an associating succeeded runs ifup for the device +waproamd requires a driver supporting the wireless extension v15 or +newer. Drivers supporting the iwevent ("wireless events") API are +useful, however not required. Unfortunately support for this API +cannot be detected automatically. Use the "-e" switch to disable it. -waproamd will not issue scans while associated. +waproamd requires a driver supporting scanning (iwlist scan) for +detecting the networks available. -The algorithm to select an AP if multiple are available is rather simple: Just take the first one having a script in /etc/waproamd/scripts. +no manpages, no further documentation included. waproamd relies on +autoconf/automake for source code configuration and building. -If a script named after the MAC address of the AP is available in /etc/waproamd/scripts/ it is run if an AP is selected. If not /etc/waproamd/scripts/default is run. Have a look on that script to see its arguments. +http://www.stud.uni-hamburg.de/users/lennart/projects/waproamd/ +http://www.stud.uni-hamburg.de/users/lennart/projects/libdaemon/ +http://www.stud.uni-hamburg.de/users/lennart/projects/ifplugd/ $Id$ -- cgit