From e502657310238e9ec6917cc10484ec9929b97c08 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 17 Nov 2003 18:57:15 +0000
Subject: man page update

git-svn-id: file:///home/lennart/svn/public/waproamd/trunk@48 022f378f-78c4-0310-b860-d162c87e6274
---
 man/waproamd.8.xml.in | 80 ++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 66 insertions(+), 14 deletions(-)

(limited to 'man')

diff --git a/man/waproamd.8.xml.in b/man/waproamd.8.xml.in
index e00667a..8fba513 100644
--- a/man/waproamd.8.xml.in
+++ b/man/waproamd.8.xml.in
@@ -92,6 +92,14 @@
       </p></optdesc>
     </option>
 
+    <option>
+      <p><opt>-W | --wait-on-kill</opt></p> 
+      
+      <optdesc><p> When killing a running daemon (with -k) wait
+      until the daemon died.
+      </p></optdesc>
+    </option>
+    
     <option> <p><opt>-M | --monitor</opt></p> <optdesc><p>Don't fail
     when the network interface is not available, instead use
     NETLINK to monitor device avaibility. The is useful for PCMCIA
@@ -135,6 +143,19 @@
       </p></optdesc>
     </option>
     
+    <option>
+      <p><opt>-S | --supend</opt></p> <optdesc><p> Suspend a running
+      daemon. The daemon will no longer check the link status until
+      it is resumed (-R) again. (Specify -i to select the daemon instance
+      to suspend.)  </p></optdesc>
+    </option>
+    
+    <option>
+      <p><opt>-R | --resume</opt></p> <optdesc><p> Resume a suspended
+      daemon. (Specify -i to select the daemon instance
+      to resume.)  </p></optdesc>
+    </option>
+    
     <option>
       <p><opt>-v | --version</opt></p>
       <optdesc><p>
@@ -142,6 +163,24 @@
       </p></optdesc>
     </option>
     
+    <option>
+      <p><opt>-r | --issue-scan</opt></p>
+      <optdesc><p>
+      Tell a running daemon to issue an immediate scan for new networks
+      </p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-U | --no-userspace-roaming</opt></p>
+      <optdesc><p> Don't enable userspace roaming as supported by
+      certain drivers (e.g. hostap). Normaly, waproamd tries to enable
+      this special feature, doing effectively the same as "iwpriv
+      wlan0 host_roaming 2". If the driver supports this private ioctl
+      the robustness of waproamd's operation is increased. However, it
+      is not required for successful use. See your driver documentation for
+      mor information on this topic.</p></optdesc>
+    </option>
+
   </options>
   
   <section name="Files">
@@ -153,25 +192,38 @@
 
     <p><file>@sysconfdir@/waproamd/scripts/&lt;AP MAC
     address&gt;</file>: this is called whenever a wireless network
-    controlled by an AP with a matching address is detected. The MAC
-    address is formatted lowercase. Takes the same arguments as the
+    controlled by an AP with a matching address is detected. The file
+    is first tried with the MAC address formatted lowercase. If no
+    script with that name exists waproamd looks for a file with the
+    MAC address formatted uppercase. Only scripts marked executable are considered. Takes the same arguments as the
     following script:</p>
+
+    <p><file>@sysconfdir@/waproamd/scripts/essid:&lt;ESSID&gt;</file>:
+    This is called whenever a wireless AP is detected but no script
+    named after the AP MAC exists (See above). If the ESSID contains
+    special chracters (ASCII code &lt; 32, &gt;= 127, '/', '%') they are
+    replaced by a character % and the hexadecimal ASCII number of the
+    character in uppercase. This is similar to the HTTP URL
+    encoding. Only scripts marked executable are considered. Takes the same arguments as the following script:</p>
     
-    <p><file>@sysconfdir@/waproamd/scripts/default</file>: this is
-    the script which is called whenever no script named after the
-    AP MAC address is found. It takes a single argument: either
-    "start" or "stop". An environment variable AP is set to the
-    MAC address of the access point found. An environment variable
-    IFACE is set to the network interface name. The default
-    implementation of this script looks for a file
+    <p><file>@sysconfdir@/waproamd/scripts/default</file>: this is the
+    script which is called when neither a script named after the
+    AP MAC address, nor a script named after the ESSID is found. It
+    takes a single argument: either "start" or "stop". An environment
+    variable AP is set to the MAC address of the access point
+    found. An environment variable IFACE is set to the network
+    interface name. An environment variable ESSID contains the ESSID
+    of the WLAN network. ESSID_ESCAPED contains the ESSID with all
+    special chracters escaped the same way as described above. The
+    default implementation of this script looks for a file
+    <file>@sysconfdir@/waproamd/keys/&lt;AP MAC address&gt;.wep</file>
+    (or named after the ESSID, following the same scheme as the script
+    selection described above). If it exists its contents is used to
+    set the WEP key of the NIC. Otherwise the script looks for a file
     <file>@sysconfdir@/waproamd/keys/&lt;AP MAC
-    address&gt;.wep</file>. If it exists its contents is used to
-    set the WEP key of the NIC. Otherwise the script looks for a
-    file <file>@sysconfdir@/waproamd/keys/&lt;AP
-    MAC address&gt;.aes</file>. If it exists the AES WEP rekeying daemon
+    address&gt;.aes</file>. If it exists the AES WEP rekeying daemon
     <manref name="aeswepd" section="8"/> is called. Otherwise WEP
     encryption is disabled.</p>
-
     
     <p><file>/var/run/waproamd.&lt;iface&gt;.pid</file>: the pid file
     for waproamd.</p>
-- 
cgit