diff options
Diffstat (limited to 'doc/README.html.in')
| -rw-r--r-- | doc/README.html.in | 192 |
1 files changed, 65 insertions, 127 deletions
diff --git a/doc/README.html.in b/doc/README.html.in index c218746..05b04a7 100644 --- a/doc/README.html.in +++ b/doc/README.html.in @@ -42,21 +42,51 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p> <h2><a name="news">News</a></h2> -<div class="news-date">Fri Sep 13 2003: </div> <p class="news-text"><a +<div class="news-date">Fri Oct 17 2003: </div> <p class="news-text"><a href="@PACKAGE_URL@waproamd-0.3.tar.gz">Version 0.3</a> released, -changes include: split <tt><a -href="http://0pointer.de/projects/aeswepd">aeswepd</a></tt> into its +changes include: split <tt><a href="http://0pointer.de/projects/aeswepd/"><tt>aeswepd</tt></a></tt> into its own package, add documentation, several bug fixes.</p> <h2><a name="overview">Overview</a></h2> +<p><tt>waproamd</tt> is a roaming daemon for wireless IEEE 802.11 NICs supporting the +Linux wireless extensions. It is intended to configure the WEP +keys according to the networks found.</p> + +<p><tt>waproamd</tt> is intended to be used together with <a href="http://0pointer.de/lennart/projects/ifplugd/"><tt>ifplugd</tt></a>. Whenever +an association succeeds, <tt>ifplugd</tt> detects it and runs further +configuration commands for it.</p> + <h2><a name="status">Status</a></h2> -<p>Version 0.3 works fine on <tt>hostap</tt> 0.0.4 and <tt>airolan</tt>.</p> +<p>Version 0.3 works fine on <a href="http://www.hostap.org"><tt>hostap</tt></a> 0.0.4 and <tt>airolan</tt>. Other driver/card combinations not tested, but may work too.</p> <h2><a name="documentation">Documentation</a></h2> -<p>Have a look on the man pages <a href="@PACKAGE_URL@waproamd.8.xml"><tt>waproamd(8)</tt></a>, <a href="@PACKAGE_URL@waproamd.conf.5.xml"><tt>waproamd.conf(5)</tt></a>. (A XSLT capable browser is required)</p> +<p>Have a look on the man pages <a href="@PACKAGE_URL@waproamd.8.xml"><tt>waproamd(8)</tt></a>, <a href="@PACKAGE_URL@waproamd.conf.5.xml"><tt>waproamd.conf(5)</tt></a>. (An XSLT capable browser is required)</p> + +<h3>Mode of Operation</h3> + +<p>As long as the local NIC is not associated to any wireless +network <tt>waproamd</tt> scans iteratively for them. If one is detected, a +script in <tt>@sysconfdir@/waproamd/scripts/</tt> named after +the MAC address of the access point is called. If this script is +not existent, <tt>@sysconfdir@/waproamd/scripts/default</tt> +is called instead. The first argument to this script is +<tt>"start"</tt>. If the association is lost, the same script is run with +the argument <tt>"stop"</tt>. While the NIC is associated no scans are +issued.</p> + +<p>If multiple WLANs are detected at the same time, the network +which is detected by the hardware first is selected. However, +networks where a matching script exists take precedence.</p> + +<p><tt>waproamd</tt> requires a network driver supporting the Linux +wireless extensions v15 or newer. The driver needs to support scanning +for wireless networks, which may be tested by running <tt>"iwlist +scan"</tt>. If the driver supports the wireless event subsystem, +waproamd may use it to improve latency behaviour. It is not required, +however.</p> <h3>Configuration</h3> @@ -67,123 +97,43 @@ one ethernet interface in <tt>INTERFACES</tt>. For each interface a seperate instance of <tt>waproamd</tt> is spawned. The arguments specified in <tt>ARGS</tt> are append to <tt>waproamd</tt>'s command line. Have a look on <tt>waproamd -h</tt> or <tt>man waproamd</tt> for further information -about the available options.</p> +about the options available.</p> -<p>The network interface which is controlled by <tt>waproamd</tt> -should not be configured automatically by your distribution's network -subsystem, since <tt>waproamd</tt> will do this for you if needed. On -Debian remove interface names beginning with <tt>eth</tt> or -<tt>wlan</tt> from the <tt>auto</tt> option line in -<tt>/etc/network/interfaces</tt>.</p> +<p>Put your WEP keys in <tt>/etc/waproamd/keys/</tt> in files named +after the AP's MAC address with an appended <tt>.wep</tt>. If the AP +uses <a +href="http://0pointer.de/projects/lennart/aeswepd/"><tt>aeswepd</tt></a> +for automatic rekeying, you may put the AES key into a file with the +suffix <tt>.aes</tt> instead.</p> -<h3>Troubleshooting</h3> +<p>The configuration is similar to <tt>ifplugd</tt>.</p> -<p>When you are using the hotplug subsystem (Debian package -<tt>hotplug</tt>) you may notice that the network device is configured -even when it is not listed on an <tt>auto</tt> line in -<tt>/etc/network/interface</tt>. This may be due to <tt>hotplug</tt> -being configured to <tt>ifup</tt> the network interface when it -becomes available. This was the default behavior in the Debian -<tt>hotplug</tt> package prior to release <tt>0.0.20030117-1</tt>, for -example. To prevent this you should either upgrade your -<tt>hotplug</tt> package or comment out the <tt>ifup</tt> call in -<tt>/etc/hotplug/net.agent</tt>.</p> - -<p>When using <tt>waproamd</tt> together with APM (and probably ACPI) -suspends, strange things may happen: some network devices fail to -detect the network cable for a short period of time before and after -the suspend. When using the <tt>-f</tt> switch, this will be treated -as "no link beat", thus the network is shutdown after a -timeout. During this timeout the machine changes to suspended -state. When it is resumed again, the timeout will be run out, the -network is deconfigured, however, as the next cable detection -succeeds, the network is configured again immediately. To fix this -problem, <tt>waproamd</tt> should be disabled before the APM suspend -and enabled back after the suspend. This may be done by using -<tt>apmd</tt> and adding a script to -<tt>/etc/apm/{suspend,resume}.d</tt> which simply calls -<tt>/etc/init.d/waproamd suspend</tt>, resp. <tt>/etc/init.d/waproamd -resume</tt>. It might even be a good idea to shut down the network -completely during suspend, this may be achieved by calling -<tt>/etc/init.d/waproamd stop</tt> and <tt>/etc/init.d/waproamd -start</tt> in the appropriate places. I strongly urge the packagers of -this software for the Linux distributions to add such scripts to their -packages.</p> - -<h3>FAQ</h3> - -<ol> - <li><p><b>Q:</b> I want to use <tt>waproamd</tt> with my PCMCIA device, but <tt>waproamd</tt> quits - when it doesn't find <tt>eth0</tt>, when I have not inserted the - card. What can I do?</p> - - <p><b>A:</b> Use the <tt>-f</tt> switch. This is not very clean however, - since modprobe is called on each cable detection query of <tt>waproamd</tt> to - load a module for the network device. This is suboptimal. You should - probably run <tt>waproamd</tt> only when the card is really inserted.</p> - </li> - - <li><p><b>Q:</b> I am using the <tt>-f</tt> switch, but the kernel logs are getting filled - with messages like "<tt>modprobe: modprobe: Can't locate module - eth0</tt>". What can I do?</p> - - <p><b>A:</b> Make sure you have a line like <tt>alias eth0 off</tt> in your <tt>/etc/modules.conf</tt></p> - </li> - - <li><p><b>Q:</b> When the cable is unplugged and the interface shut down it is - still available with <tt>ifconfig</tt> and markes as UP. Why this?</p> - - <p><b>A:</b> <tt>waproamd</tt> cannot detect the link beat with a shut down interface on - certain (most as of kernel 2.4.19) network drivers. Thus <tt>waproamd</tt> - enables the interface before querying the link status. This may - be switched off with -a flag. You might want to use it if you - have a sane network driver (e.g. <tt>eepro100</tt>). The subdirectory - <tt>patches/</tt> in the <tt>waproamd</tt> distribution includes a patch for the - 8139too 0.9.26 driver, which makes the driver compatible with - -a. Don't ask me how to apply this patch. If you don't know, you - won't need it.</p></li> - - <li><p><b>Q:</b> Does it work with anything else than plain ethernet or wireless LAN?</p> - - <p><b>A:</b> Certainly not, since the <tt>MII</tt> and -<tt>ETHTOOL</tt> <tt>ioctl()</tt>s and the wireless extension don't -exist on - other network device types.</p></li> - - <li><p><b>Q:</b> I have a Realtek 8139 based network card. Everytime <tt>waproamd</tt> - starts on bootup my machine freezes. What can I do?</p> - - <p><b>A:</b> This is a bug in the <tt>8139too</tt> driver 0.9.25 (at least) shipped - with Linux 2.4.19, please upgrade to <tt>8139too</tt> 0.9.26 (Linux 2.4.20 - or seperately at <a href="http://www.sourceforge.net/projects/gkernel/">http://www.sourceforge.net/projects/gkernel/</a>).</p></li> - - - <li><p><b>Q:</b> There are already <tt>laptop-net</tt>'s <tt>ifd</tt> and <tt>miid</tt>, why did you write - your own daemon?</p> - - <p><b>A:</b> <tt>laptop-net</tt> simply sucks and I didn't know of <tt>miid</tt> when I wrote - <tt>waproamd</tt>. However, <tt>waproamd</tt> is far better than <tt>miid</tt>. For a - comparison of <tt>miid</tt> and <tt>waproamd</tt>, have a look on - - <a href="http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=162763&repeatmerged=yes">http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=162763&repeatmerged=yes</a></p></li> -</ol> +<h3>Troubleshooting</h3> +<p>Not all drivers/cards support the wireless event subsystem of the +Linux wireless extensions. Its support on your machine cannot be +detected automatically, you have to test it yourself with <tt>"iwlist +scan"</tt>. See <tt>man 8 iwlist</tt> for more information. If your +driver/card combination does not support this, you have to enable +polling of association status by passing <tt>-e</tt> on the command +line. This will increase the reaction latency of waproamd.</p> <h2><a name="requirements">Requirements</a></h2> -<p>A newer Linux Kernel (I think 2.2 is good enough, alltough I tested it -only with 2.4) with a compatible device driver and -ethernet card. Most modern cards and drivers are compatible, like mine -which works with the <tt>8139too</tt> driver.</p> +<p>A newer Linux Kernel with a compatible device driver and WLAN NIC +(Wireless extensions v15 or newer). Most modern cards and drivers are +compatible, like mines which work with the <a +href="http://www.hostap.org/"><tt>hostap</tt></a> driver, version +0.0.3 and above. The driver has to support the scanning interface, +wireless event support ist nice to have.</p> <p><tt>waproamd</tt> was developed and tested on Debian GNU/Linux -"testing" from July 2003, it should work on most other Linux -distributions (and maybe Unix versions) since it uses GNU autoconf and -GNU libtool for source code configuration and shared library -management.</p> +"testing" from October 2003, it should work on most other Linux +distributions since it uses GNU autoconf for source code +configuration.</p> -<p>The machine used was a Medion 9580-F laptop with a Realtek 8139 -network card and a PRISM1 PCMCIA wireless LAN card.</p> +<p>The machines used for development are a Medion 9580-F laptop with a +TEAC and a ZONET PCMCIA WLAN NIC. Both cards feature a PRISM2 chipset. <tt>hostap 0.0.4</tt> was used as driver.</p> <p><tt>waproamd</tt> needs <a href="http://0pointer.de/lennart/projects/libdaemon/"><tt>libdaemon</tt></a>.</p> @@ -202,15 +152,7 @@ for it.</p> <h2><a name="acks">Acknowledgements</a></h2> -<p>For the developers of <tt>mii-diag</tt>, <tt>ethtool</tt> and <tt>laptop-net</tt>, since I looked -on their source codes for learning how to use the link beat ioctls.</p> - -<p>Oliver Kurth for packaging <tt>waproamd</tt> for Debian and <tt>waproamd</tt>'s -manpage</p> - -<p>Asgeir Nilsen, Sean Reifschneider, R. Steve McKown, David Mitchell for patches</p> - -<p>Frederic Lepied for integrating <tt>waproamd</tt> into Mandrake Linux</p> +<p>None so far</p> <h2><a name="download">Download</a></h2> @@ -220,13 +162,9 @@ manpage</p> <p>Get <tt>waproamd</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/waproamd/">repository</a>.</p> -<p>You may find a mostly up to date Debian package of <tt>waproamd</tt> on the <a href="http://packages.debian.org/waproamd">Debian package repository</a>.</p> - -<p>Packages for Mandrake Linux may be found in the Cooker distribution; Gentoo packages are available as well</p> - <hr/> -<address>Lennart Poettering <@PACKAGE_BUGREPORT@>, Oct 2003</address> -<div><i>$Id: README.html.in 48 2003-09-13 11:36:11Z lennart $</i></div> +<address>Lennart Poettering <@PACKAGE_BUGREPORT@>, October 2003</address> +<div><i>$Id$</i></div> </body> </html> |