documenation fixes

git-svn-id: file:///home/lennart/svn/public/waproamd/trunk@50 022f378f-78c4-0310-b860-d162c87e6274

3 files changed, 53 insertions, 21 deletions

diff --git a/doc/README.html.in b/doc/README.html.in
index 726dec3..ebcccab 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -42,6 +42,13 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
 
 <h2><a name="news">News</a></h2>
 
+<div class="news-date">Mon Nov 17 2003: </div> <p class="news-text"><a
+href="@PACKAGE_URL@waproamd-0.4.tar.gz">Version 0.4</a> released,
+changes include: support for ESSID based configuration,
+<tt>host_roaming</tt> private ioctl support on <tt>hostap</tt> drivers, ability to
+suspend/resume the daemon, support for looking for uppercase MAC
+scripts, many robustness fixes.</p>
+
 <div class="news-date">Fri Oct 17 2003: </div> <p class="news-text"><a
 href="@PACKAGE_URL@waproamd-0.3b.tar.gz">Version 0.3b</a> released,
 changes include: minor bug fixes.</p>
@@ -61,9 +68,11 @@ keys according to the networks found.</p>
 an association succeeds, <tt>ifplugd</tt> detects it and runs further
 configuration commands for it.</p>
 
+<p>An alternative implementation of a tool like this is <a href="http://jelmer.vernstok.nl/oss/wlandetect/"><tt>wlandetect</tt></a>.</p>
+
 <h2><a name="status">Status</a></h2>
 
-<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>
+<p>Version @PACKAGE_VERSION@ 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>
 
@@ -71,15 +80,18 @@ configuration commands for it.</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>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. (First lowercase, than
+uppercase is checked) If a script like this is not found a script
+named <tt>essid:&lt;ESSID&gt;</tt> in the same directory is
+used. Special characters are escaped in an HTTP URL like fashion. 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,
@@ -92,6 +104,12 @@ scan"</tt>. If the driver supports the wireless event subsystem,
 waproamd may use it to improve latency behaviour. It is not required,
 however.</p>
 
+<p>waproamd supports the <tt>host_roaming</tt> private <tt>ioctl()</tt> as defined by the <a href="http://hostap.epitest.fi">hostap</a> driver.</p>
+
+<p>Don't forget to install a firewall on your computer, since
+<tt>waproamd</tt> will try to log into any network it finds with
+default settings, if not configured otherwise. Yes, you a right, <tt>waproamd</tt> is war-driving on steroids.</p>
+
 <h3>Configuration</h3>
 
 <p>Edit <tt>/etc/waproamd/waproamd.conf</tt> for configuration
@@ -99,7 +117,7 @@ changes. This file is a bourne shell script sourced by the init script
 and used to generate a suiting command line. You may specify more than
 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>ARGS</tt> are appended 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 options available.</p>
 
@@ -110,7 +128,7 @@ 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>
 
-<p>The configuration is similar to <tt>ifplugd</tt>.</p>
+<p>The configuration is similar to <a href="http://0pointer.de/lennart/projects/ifplugd/"><tt>ifplugd</tt></a>.</p>
 
 <h3>Troubleshooting</h3>
 
@@ -122,6 +140,9 @@ 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>
 
+<p>You can priorize networks over others by adding symbolic links to
+the <tt>default</tt> script to <tt>/etc/waproamd/scripts</tt>.</p>
+
 <h2><a name="requirements">Requirements</a></h2>
 
 <p>A newer Linux Kernel with a compatible device driver and WLAN NIC
@@ -158,6 +179,8 @@ for it.</p>
 
 <p>Thomas Hood for patches</p>
 
+<p>Oliver Kurth for packaging <tt>waproamd</tt> for Debian</p>
+
 <h2><a name="download">Download</a></h2>
 
 <p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>
@@ -166,6 +189,8 @@ for it.</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>.
+
 <hr/>
 <address>Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, October 2003</address>
 <div><i>$Id$</i></div>
diff --git a/man/waproamd.8.xml.in b/man/waproamd.8.xml.in
index 8fba513..ed56b1c 100644
--- a/man/waproamd.8.xml.in
+++ b/man/waproamd.8.xml.in
@@ -37,12 +37,15 @@
     <p>As long as the local NIC is not associated to any wireless
     network waproamd scans iteratively for them. If one is detected, a
     script in <file>@sysconfdir@/waproamd/scripts/</file> named after
-    the MAC address of the access point is called. If this script is
-    not existent, <file>@sysconfdir@/waproamd/scripts/default</file>
-    is called instead. The first argument to this script is
-    "start". If the association is lost, the same script is run with
-    the argument "stop". While the NIC is associated no scans are
-    issued.</p>
+    the MAC address of the access point is called. (First lowercase,
+    than uppercase is checked) If a script like this is not found a
+    script named <tt>essid:&lt;ESSID&gt;</tt> in the same directory is
+    used. Special characters are escape in an HTTP URL like
+    fashion. If this script is not existent,
+    <file>@sysconfdir@/waproamd/scripts/default</file> is called
+    instead. The first argument to this script is "start". If the
+    association is lost, the same script is run with the argument
+    "stop". While the NIC is associated no scans are issued.</p>
 
     <p>waproamd is intended to be used together with ifplugd. Whenever
     an association succeeds, ifplugd detects it and runs further
@@ -59,6 +62,9 @@
     subsystem, waproamd may use it to improve latency behaviour. It is
     not required, however.</p>
 
+    <p>waproamd supports the host_roaming ioctl() defined by the
+    hostap driver.</p>
+
   </description>
   
   <options>
diff --git a/src/waproamd.c b/src/waproamd.c
index 41cfa3f..91dd26b 100644
--- a/src/waproamd.c
+++ b/src/waproamd.c
@@ -274,10 +274,8 @@ int go(struct interface *i) {
     /* Try to enable userspace roaming in the driver */
     if (!disabled && use_userspace_roaming) {
 
-        if (iw_set_hostroam(i, 2) < 0) {
+        if (iw_set_hostroam(i, 2) < 0)
             daemon_log(LOG_WARNING, "Enabling user space roaming failed, doing without.");
-            use_userspace_roaming = 0;
-        }
     }
 
     memset(&current_ap, 0, sizeof(current_ap));
@@ -406,6 +404,9 @@ int go(struct interface *i) {
             if (d && !disabled) {
                 daemon_log(LOG_INFO, "Interface enabled");
                 associated = scanning = 0;
+
+                if (iw_set_hostroam(i, 2) < 0)
+                    daemon_log(LOG_WARNING, "Enabling user space roaming failed, doing without.");
             }
 
             if (!disabled) {